home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 24 / AACD 24.iso / AACD / Online / Epic4 / share / epic / help / 6_functions / nohighlight < prev    next >
Text File  |  2001-03-21  |  822b  |  25 lines
  1. Synopsis:
  2.    $nohighlight(<string>)
  3.  
  4. Technical:
  5.    This function returns <string> with all highlight characters escaped.
  6.    All ^B, ^V, ^_, ^O, ^C, and ^[ characters will be replaced by an inverse
  7.    of their control character, to remove all highlighting.
  8.  
  9. Practical:
  10.    This is a very useful function, which has had many forms in scripts for
  11.    a long time. It is especially good to mask out ^C and ANSI color codes
  12.    in order to make for color-free output, or in a public message hook to
  13.    immune yourself from ANSI-bombs that may mess up a terminal.
  14.  
  15. Returns:
  16.    <string> with no parseable highlight characters, except the reverse used
  17.    to show the control character.
  18.  
  19. Examples:
  20.    $nohighlight(this is a test)           Returns "this BisB a VtestV"
  21.  
  22. See Also:
  23.    stripansi(6); tr(6)
  24.  
  25.